Skip to main content

Installation

The web library is normally supplied as a pre-bundled JavaScript library hosted on a content distribution network (CDN). It is also possible to include the web library as an npm package from our private registry - please contact support@datawollet.com if you require access.

Requirements​

  • Node.js version 18.0 or above (which can be checked by running node -v) is recommended when using the web library distributed as a package.
  • WebGL 2.0 support is required for document scanning. The library detects device compatibility automatically.
  • JavaScript module support is recommended when using the web library distributed from our CDN.

Adding the library​

We recommend including the script tag within the <head> element of the page, optionally with a defer attribute as module type scripts should be deferred automatically.

warning

Adding the library script is not the only step required to use the web library. It must be initialised with a configuration before DataWollet will have any effect on the page.

Multiple script tags with the defer attribute are guaranteed to run in the order they appear on the page. Ensure the library is loaded before it is initialised.

The following example includes the latest version of the web library.

<script
  type="module"
  src="https://cdn.datawollet.com/web/js/datawollet-web-library/latest.js"
  defer
/>

Managed service​

If DataWollet is providing a managed service including customisations or bespoke document formats, then we'll supply you with your own script tag to use. This will load both the library and your base configuration simultaneously.

You can still access the library functions directly in your own code (e.g. event callbacks) and use your own stylesheets for additional customisation, but you should contact DataWollet if you need to make changes to the HTML elements or configuration.

Versions​

A specific version number can be pinned using the formats vX, vX.X, or vX.X.X in place of latest.

DataWollet uses a semantic versioning approach to its library, with any breaking changes to the configuration or behaviour resulting in a new major version number.

warning

The web library's behaviour is also dependent on AI profiles for reading documents, and recipes for auto-filling the page. These are versioned independently.

Problems?​

Ask for help by emailing support@datawollet.com or your contact at DataWollet.